Skip to content

feat(ws): add @ID swag annotation to handlers #488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

andyatmiami
Copy link
Contributor

@andyatmiami andyatmiami commented Jul 17, 2025

related: #46

  • added @ID annotations for all API routes to populate operationId Swagger attribute
  • split GetWorkspacesHandler into 2 separate handlers to account for @id needing to be unique-per-route
    • GetAllWorkspacesHandler now services GET /workspaces
    • GetWorkspacesByNamespaceHandler now services GET /workspaces/{namespace}
    • non-exported getWorkspacesHandler function contains all business logic that existed in GetWorkspacesHandler
  • Adjusted test cases to align with the new handler names.

@github-project-automation github-project-automation bot moved this to Needs Triage in Kubeflow Notebooks Jul 17, 2025
@google-oss-prow google-oss-prow bot added the area/backend area - related to backend components label Jul 17, 2025
@google-oss-prow google-oss-prow bot added area/v2 area - version - kubeflow notebooks v2 size/L labels Jul 17, 2025
@andyatmiami andyatmiami force-pushed the feat/swagger-operationId branch 2 times, most recently from 77634fa to de75137 Compare July 17, 2025 21:18
@caponetto
Copy link

/lgtm

@thesuperzapper
Copy link
Member

/ok-to-test

@andyatmiami andyatmiami force-pushed the feat/swagger-operationId branch from de75137 to 3bf6ffb Compare July 26, 2025 13:22
@google-oss-prow google-oss-prow bot removed the lgtm label Jul 26, 2025
- added @id annotations for all API routes to populate operationId Swagger attribute
- split GetWorkspacesHandler into 2 separate handlers to account for @id needing to be unique-per-route
    - GetAllWorkspacesHandler now services GET /workspaces
    - GetWorkspacesByNamespaceHandler now services GET /workspaces/{namespace}
    - non-exported getWorkspacesHandler function contains all business logic that existed in GetWorkspacesHandler
- Adjusted test cases to align with the new handler names.

Signed-off-by: Andy Stoneberg <[email protected]>
@andyatmiami andyatmiami force-pushed the feat/swagger-operationId branch from 3bf6ffb to 22c2106 Compare July 26, 2025 13:33
@caponetto
Copy link

/lgtm

@google-oss-prow google-oss-prow bot added the lgtm label Jul 29, 2025
@thesuperzapper thesuperzapper changed the title feat(ws): add @ID swag annotation for better codegen readability feat(ws): add @ID swag annotation to handlers Jul 31, 2025
@thesuperzapper
Copy link
Member

Thanks @andyatmiami!

/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: thesuperzapper

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit 639c24e into kubeflow:notebooks-v2 Jul 31, 2025
12 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Kubeflow Notebooks Jul 31, 2025
@andyatmiami andyatmiami deleted the feat/swagger-operationId branch August 6, 2025 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/backend area - related to backend components area/v2 area - version - kubeflow notebooks v2 lgtm ok-to-test size/L
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants